extends TemplatedHtmlPage
Submit forms to this resource (usually on /contactus) as a POST to send contact email requests The contactus form page is conceptually very similar to the group registration page. Both will create a profile if it doesnt exist and you can submit data to both, and both can trigger events to send emails, etc. The difference is that a contact submission only creates new data, it never changes existing data. Whereas registering a user can allow existing profile data to be modified.
Captcha
If a Captcha app is enabled it will be used to verify the response. You can customise the error response message by sending a parameter called invalidCaptchaMessageProperties
| Name | Returns | Notes | Example |
|---|---|---|---|
| intro | String | Content to appear above the form | |
| thankYouMessage | String | Pulls the thankyou setting from application settings, or returns a default message | |
| modifiedDate | Date | ||
| createDate | Date | ||
| optins | List | ||
| numRequests | long | Count of all contact requests submitted on this website, ever | |
| mostRecentRequest | ContactRequestBean | Find the most recent request by the current user | |
| captchaApp | CaptchaApplication | If there is a Captcha app enabled for this site,return it |
Methods
| Name | Returns | Notes | Example |
|---|---|---|---|
| findRequests ( formPath ) | List | Returns a list of ContactRequestBeanm which are the contact requests for the current user matching the given parameters These are ordered by their createdDate descending, so most recent request is first | |
| findRequests ( from, to, limit, formPath ) | List | Returns a list of ContactRequestBeanm which are the contact requests for the matching the given parameters These are ordered by their createdDate descending, so most recent request is first | |
| numRequests ( from, to, formPath ) | long | Count contact requests for the given date range (if not null) and optional contact form path | |
| getMostRecentRequest ( ) | ContactRequestBean | Find the most recent request by the current user | |
| mostRecentRequests ( profileBean ) | List | Returns a list of ContactRequestBean for the given user | |
| myRequests ( formPath ) | List | Get requests for the currently logged in user for the given form path Returns a list of ContactRequestBean |
REST Operations
- GET with checkEmail=someemail@mydomain.com, returns a JSON response saying whether the email is registered in the contact group. You can send a contactForm parameter just as you would with an actual form submit, otherwise the referrer header will be used to identify the form metadata.Hide comments
